Conversation
Document repo setup, workflows, and guardrails for AI agents.
There was a problem hiding this comment.
Pull request overview
This PR adds AGENTS.md, a comprehensive documentation file designed to guide AI agents (like GitHub Copilot) working with this repository. The document provides a structured overview of the codebase, setup instructions, workflows, and guardrails to help AI tools understand the project context.
Changes:
- Added
AGENTS.mdwith sections covering project overview, repository structure, quickstart commands, development workflows, testing/CI, code style conventions, security guardrails, common tasks, and references to further reading
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| - Seeds (dev): `docker compose run --rm api rails projects:create_all` and | ||
| `docker compose run --rm api rails for_education:seed_a_school_with_lessons_and_students` | ||
| (others in README). | ||
| - DB sync (needs Heroku access): `./bin/db-sync/production-to-local.sh` or `staging-to-local.sh`. |
There was a problem hiding this comment.
Should we be encouraging agents to run this?
| ## Repository Structure | ||
| - `app/` Rails application code (REST, GraphQL, jobs, views, admin). | ||
| - `config/` environment, initializers, Puma, CORS, credentials. | ||
| - `db/` migrations, seeds, schema helpers; `bin/db-sync/` for pulling Heroku data locally. |
There was a problem hiding this comment.
(same as below) - should be be encouraging agents to run bin/db-sync/?
zetter-rpf
left a comment
zetter-rpf
left a comment
There was a problem hiding this comment.
Approved - looks like a useful base for us to start with and add things to.
Added a couple of optional comments
|
Doing something unrelated, I found that we already have a |
2 participants
Document repo setup, workflows, and guardrails for AI agents.
Status
Points for consideration:
What's changed?
Steps to perform after deploying to production